<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class sl_web_login_funcs</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface sl_web_login_funcs</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Declares the public interface to <a href="../WebLogin/sl_web_login.html">sl_web_login</a></p>
		<p class="notes">
			Located in <a class="field" href="_web-login.php.html">/web-login.php</a> (line <span class="field">23</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																												<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#login_url" title="details" class="method-name">login_url</a>
										()
									</div>
																								<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#uuid_regex" title="details" class="method-name">uuid_regex</a>
										()
									</div>
																								<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#web_login_key_regex" title="details" class="method-name">web_login_key_regex</a>
										()
									</div>
								
												<div class="method-definition">
											<span class="method-result">sl_web_login_funcs</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$first</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$last</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span> = <span class="var-default">'home'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$grid</span> = <span class="var-default">'agni'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$continuation</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#continuation" title="details" class="method-name">continuation</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string|null</span>
										<a href="#error" title="details" class="method-name">error</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#first" title="details" class="method-name">first</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#grid" title="details" class="method-name">grid</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#info" title="details" class="method-name">info</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#last" title="details" class="method-name">last</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#location" title="details" class="method-name">location</a>
										()
									</div>
																								<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#uuid" title="details" class="method-name">uuid</a>
										()
									</div>
																								<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#web_login_key" title="details" class="method-name">web_login_key</a>
										()
									</div>
																</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodlogin_url" id="login_url"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method login_url</span> (line <span class="line-number">84</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the URL to use with cURL for the web login operation</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/LindenLabWebLogin/LL_sl_web_login.html#methodlogin_url">LL_sl_web_login::login_url()</a></li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#method__construct">sl_web_login::__construct()</a></li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			login_url
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoduuid_regex" id="uuid_regex"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method uuid_regex</span> (line <span class="line-number">94</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the regex to use in order to extract the agent key</p>
	<ul class="tags">
				<li><span class="field">return:</span> a regex string compatible with <a href="http://uk.php.net/preg_match">preg_match</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/LindenLabWebLogin/LL_sl_web_login.html#methoduuid_regex">LL_sl_web_login::uuid_regex()</a></li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methodget_uuid">sl_web_login::get_uuid()</a></li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			uuid_regex
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodweb_login_key_regex" id="web_login_key_regex"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method web_login_key_regex</span> (line <span class="line-number">89</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the regex to use in order to extract the web login key</p>
	<ul class="tags">
				<li><span class="field">return:</span> a regex string compatible with <a href="http://uk.php.net/preg_match">preg_match</a></li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/LindenLabWebLogin/LL_sl_web_login.html#methodweb_login_key_regex">LL_sl_web_login::web_login_key_regex()</a></li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methodget_web_login_key">sl_web_login::get_web_login_key()</a></li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">string</span>
		<span class="method-name">
			web_login_key_regex
		</span>
				()
			</div>
	
		
			
	</div>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">79</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Configures the cURL operation for the web login operation</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#method__construct">sl_web_login::__construct()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">sl_web_login_funcs</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$first</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$last</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$location</span> = <span class="var-default">'home'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$grid</span> = <span class="var-default">'agni'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$continuation</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$first</span><span class="var-description">: see {@see sl_web_login_funcs::first()}</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$last</span><span class="var-description">: see  {@see sl_web_login_funcs::last()}</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span><span class="var-description">: the agent's password</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$location</span><span class="var-description">: see  {@see sl_web_login_funcs::location()}</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$grid</span><span class="var-description">: see  {@see sl_web_login_funcs::grid()}</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$continuation</span><span class="var-description">: see  {@see sl_web_login_funcs::continuation()}</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcontinuation" id="continuation"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">continuation</span> (line <span class="line-number">59</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the continuation parameter provided in <a href="../WebLogin/sl_web_login.html#method__construct">sl_web_login::__construct()</a></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methodcontinuation">sl_web_login::continuation()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			continuation
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoderror" id="error"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">error</span> (line <span class="line-number">69</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the error associated with the web login cURL operation</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methoderror">sl_web_login::error()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|null</span>
		<span class="method-name">
			error
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodfirst" id="first"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">first</span> (line <span class="line-number">39</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the fist name provided in <a href="../WebLogin/sl_web_login.html#method__construct">sl_web_login::__construct()</a></p>
	<ul class="tags">
				<li><span class="field">return:</span> The agent's first name</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methodfirst">sl_web_login::first()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			first
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgrid" id="grid"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">grid</span> (line <span class="line-number">54</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the grid provided in <a href="../WebLogin/sl_web_login.html#method__construct">sl_web_login::__construct()</a></p>
	<ul class="tags">
				<li><span class="field">return:</span> The desired grid to log into</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methodgrid">sl_web_login::grid()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			grid
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodinfo" id="info"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">info</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the cURL info for the web login operation</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methodinfo">sl_web_login::info()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			info
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlast" id="last"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">last</span> (line <span class="line-number">44</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the last name provided in <a href="../WebLogin/sl_web_login.html#method__construct">sl_web_login::__construct()</a></p>
	<ul class="tags">
				<li><span class="field">return:</span> The agent's last name</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methodlast">sl_web_login::last()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			last
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodlocation" id="location"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">location</span> (line <span class="line-number">49</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the location provided in <a href="../WebLogin/sl_web_login.html#method__construct">sl_web_login::__construct()</a></p>
	<ul class="tags">
				<li><span class="field">return:</span> The desired location for the agent to log into</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../WebLogin/sl_web_login.html#methodlocation">sl_web_login::location()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			location
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoduuid" id="uuid"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">uuid</span> (line <span class="line-number">34</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the <a href="http://wiki.secondlife.com/wiki/UUID">UUID</a> for the agent logging in.</p>
	<ul class="tags">
				<li><span class="field">return:</span> a <a href="http://wiki.secondlife.com/wiki/UUID">UUID</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			uuid
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodweb_login_key" id="web_login_key"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">web_login_key</span> (line <span class="line-number">29</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the web login key to pass back to the viewer/bot</p>
	<ul class="tags">
				<li><span class="field">return:</span> a <a href="http://wiki.secondlife.com/wiki/UUID">UUID</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			web_login_key
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sat, 26 Jul 2008 01:31:32 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>